fix(docker): trim the Docker Hub overview to before Bare metal, not by byte count - #4
Merged
Merged
Conversation
…y byte count Replaced the previous byte-budget truncation (which cut wherever 25,000 bytes happened to land - mid-code-block, mid-table, anywhere) with a structural cut: everything from the top through the Docker Quick Start, stopping right before "### Bare metal". That's the section a Docker Hub visitor actually wants - bare metal, Apache, shared hosting and the full reference are either irrelevant to someone looking at a container image or better read in full on GitHub anyway. The cut sits at roughly 6,900 bytes, about a quarter of the 25,000-byte limit, so no truncation-within-the-cut is needed - a closing link to the full README covers everything after. Kept a last-resort hard truncation in case that section ever grows past the limit on its own, so a future README change fails safely instead of getting the whole request rejected. No separate trimmed file is committed anywhere - this is produced fresh from the one README.md each time the workflow runs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Replaces the byte-count truncation for the Docker Hub Overview with a structural cut: everything from the top of
README.mdthrough the Docker Quick Start, stopping right before### Bare metal. That's what a Docker Hub visitor actually wants — bare metal, Apache, shared hosting, and the full configuration/HTTP API/CLI reference are either irrelevant to someone looking at a container image, or better read in full on GitHub anyway. A closing line links to the complete README for the rest.The cut lands at ~6,890 bytes — about a quarter of Docker Hub's 25,000-byte
full_descriptionlimit — so there's no truncation-within-the-cut needed anymore (no more risk of stopping mid-code-block or mid-table). Kept a last-resort hard truncation in case that section ever grows past the limit on its own, so a future README change fails safely instead of the whole API request being rejected.No separate trimmed file exists anywhere in the repo — this is produced fresh from the one
README.mdeach time the workflow runs, per the earlier request not to commit a trimmed copy.Verified for real
Dispatched against the current release and confirmed live:
hub.docker.com/r/dmanavi/ddns's Overview is now exactly 6,890 bytes, starting with the README's title/badges and ending with the Docker section's last tip, a---, and the link to the full README. Byte-for-byte matches a local dry run done before touching CI.Merging this
Contains a
fixcommit, so merging will trigger a new release per the repo's automation.